<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">

	<title>MGSwipeTableCell Class Reference</title>

	<link rel="stylesheet" href="../css/style.css">
	<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
	<meta name="generator" content="appledoc 2.2.1 (build 1334)">
</head>
<body class="appledoc">
	<header>
		<div class="container" class="hide-in-xcode">
			
			<h1 id="library-title">
				<a href="../index.html">OBMessenger </a>
			</h1>

			<p id="developer-home">
				<a href="../index.html">On-Bright</a>
			</p>
			
		</div>
	</header>

	<aside>
		<div class="container">
			<nav>
				<ul id="header-buttons" role="toolbar">
					<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>

					<li id="on-this-page" role="navigation">
						<label>
							On This Page

							<div class="chevron">
								<div class="chevy chevron-left"></div>
								<div class="chevy chevron-right"></div>
							</div>

							<select id="jump-to">
	<option value="top">Jump To&#133;</option>
	
	<option value="overview">Overview</option>
	

	
	
	<option value="tasks">Tasks</option>
	
	

	
	
	<optgroup label="Properties">
		
		<option value="//api/name/delegate">delegate</option>
		
		<option value="//api/name/isSwipeGestureActive">isSwipeGestureActive</option>
		
		<option value="//api/name/leftButtons">leftButtons</option>
		
		<option value="//api/name/leftExpansion">leftExpansion</option>
		
		<option value="//api/name/swipeBackgroundColor">swipeBackgroundColor</option>
		
		<option value="//api/name/swipeContentView">swipeContentView</option>
		
		<option value="//api/name/swipeOffset">swipeOffset</option>
		
		<option value="//api/name/swipeState">swipeState</option>
		
	</optgroup>
	

	

	
	<optgroup label="Instance Methods">
		
		<option value="//api/name/hideSwipeAnimated:">- hideSwipeAnimated:</option>
		
		<option value="//api/name/refreshButtons:">- refreshButtons:</option>
		
		<option value="//api/name/refreshContentView">- refreshContentView</option>
		
	</optgroup>
	
	
</select>
						</label>
					</li>
				</ul>
			</nav>
		</div>
	</aside>

	<article>
		<div id="overview_contents" class="container">
			<div id="content">
				<main role="main">
					<h1 class="title">MGSwipeTableCell Class Reference</h1>

					
					<div class="section section-specification"><table cellspacing="0"><tbody>
						<tr>
	<th>Inherits from</th>
	<td>UITableViewCell</td>
</tr><tr>
	<th>Declared in</th>
	<td>MGSwipeTableCell.h</td>
</tr>
						</tbody></table></div>
					

                    
					
					<div class="section section-overview">
						<a title="Overview" name="overview"></a>
						<h2 class="subtitle subtitle-overview">Overview</h2>
						<p>Swipe Cell class
To implement swipe cells you have to override from this class
You can create the cells programmatically, using xibs or storyboards</p>
					</div>
					
					

					
					
					<div class="section section-tasks">
						<a title="Tasks" name="tasks"></a>
						

						
						

						<div class="task-list">
							<div class="section-method">
	<a name="//api/name/delegate" title="delegate"></a>
	<h3 class="method-title"><code><a href="#//api/name/delegate">&nbsp;&nbsp;delegate</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>optional delegate (not retained)</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, weak, nullable) id&lt;MGSwipeTableCellDelegate&gt; delegate</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">MGSwipeTableCell.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/swipeContentView" title="swipeContentView"></a>
	<h3 class="method-title"><code><a href="#//api/name/swipeContentView">&nbsp;&nbsp;swipeContentView</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>optional to use contentView alternative. Use this property instead of contentView to support animated views while swiping</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, strong, readonly, nonnull) UIView *swipeContentView</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">MGSwipeTableCell.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/leftButtons" title="leftButtons"></a>
	<h3 class="method-title"><code><a href="#//api/name/leftButtons">&nbsp;&nbsp;leftButtons</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Left and right swipe buttons and its settings.
Buttons can be any kind of UIView but it&rsquo;s recommended to use the convenience <a href="../Classes/MGSwipeButton.html">MGSwipeButton</a> class</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, copy, nonnull) NSArray&lt;UIView*&gt; *leftButtons</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">MGSwipeTableCell.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/leftExpansion" title="leftExpansion"></a>
	<h3 class="method-title"><code><a href="#//api/name/leftExpansion">&nbsp;&nbsp;leftExpansion</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Optional settings to allow expandable buttons</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, strong, nonnull) MGSwipeExpansionSettings *leftExpansion</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">MGSwipeTableCell.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/swipeState" title="swipeState"></a>
	<h3 class="method-title"><code><a href="#//api/name/swipeState">&nbsp;&nbsp;swipeState</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Readonly property to fetch the current swipe state</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, readonly) MGSwipeState swipeState</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">MGSwipeTableCell.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/isSwipeGestureActive" title="isSwipeGestureActive"></a>
	<h3 class="method-title"><code><a href="#//api/name/isSwipeGestureActive">&nbsp;&nbsp;isSwipeGestureActive</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Readonly property to check if the user swipe gesture is currently active</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, readonly) BOOL isSwipeGestureActive</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">MGSwipeTableCell.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/swipeBackgroundColor" title="swipeBackgroundColor"></a>
	<h3 class="method-title"><code><a href="#//api/name/swipeBackgroundColor">&nbsp;&nbsp;swipeBackgroundColor</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Optional background color for swipe overlay. If not set, its inferred automatically from the cell contentView</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, strong, nullable) UIColor *swipeBackgroundColor</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">MGSwipeTableCell.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/swipeOffset" title="swipeOffset"></a>
	<h3 class="method-title"><code><a href="#//api/name/swipeOffset">&nbsp;&nbsp;swipeOffset</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Property to read or change the current swipe offset programmatically</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) CGFloat swipeOffset</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">MGSwipeTableCell.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/hideSwipeAnimated:" title="hideSwipeAnimated:"></a>
	<h3 class="method-title"><code><a href="#//api/name/hideSwipeAnimated:">&ndash;&nbsp;hideSwipeAnimated:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Utility methods to show or hide swipe buttons programmatically</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (void)hideSwipeAnimated:(BOOL)<em>animated</em></code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">MGSwipeTableCell.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/refreshContentView" title="refreshContentView"></a>
	<h3 class="method-title"><code><a href="#//api/name/refreshContentView">&ndash;&nbsp;refreshContentView</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Refresh method to be used when you want to update the cell contents while the user is swiping</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (void)refreshContentView</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">MGSwipeTableCell.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/refreshButtons:" title="refreshButtons:"></a>
	<h3 class="method-title"><code><a href="#//api/name/refreshButtons:">&ndash;&nbsp;refreshButtons:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Refresh method to be used when you want to dynamically change the left or right buttons (add or remove)
If you only want to change the title or the backgroundColor of a button you can change it&rsquo;s properties (get the button instance from <a href="#//api/name/leftButtons">leftButtons</a> or rightButtons arrays)</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (void)refreshButtons:(BOOL)<em>usingDelegate</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>usingDelegate</code></th>
						<td><p>if YES new buttons will be fetched using the <a href="../Protocols/MGSwipeTableCellDelegate.html">MGSwipeTableCellDelegate</a>. Otherwise new buttons will be fetched from leftButtons/rightButtons properties.</p></td>
					</tr>
				
				</table>
			</div>
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">MGSwipeTableCell.h</code></p>
			</div>
			
			
		</div>
	</div>
</div>
						</div>
						
					</div>
					
					

                    
                    
          
				</main>

				<footer>
					<div class="footer-copyright">
						
						<p class="copyright">Copyright &copy; 2017 On-Bright. All rights reserved. Updated: 2017-06-09</p>
						
						
						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>
						
					</div>
				</footer>
			</div>
		</div>
	</article>

	<script src="../js/script.js"></script>
</body>
</html>